Skip to content

docs: keys, architecture & troubleshooting guides + README polish - #7

Merged
zackkitzmiller merged 2 commits into
mainfrom
docs/keys-architecture-troubleshooting
Jul 26, 2026
Merged

docs: keys, architecture & troubleshooting guides + README polish#7
zackkitzmiller merged 2 commits into
mainfrom
docs/keys-architecture-troubleshooting

Conversation

@zackkitzmiller

Copy link
Copy Markdown
Member

Delivers the outstanding docs request and a README accuracy pass.

New docs

  • docs/keys.md β€” complete key reference, including the two-zone (rail/panel) focus model, the global vs zone-scoped key split, per-screen action conventions, and the command palette.
  • docs/architecture.md β€” package layout, the strict domainβ†’TUI dependency boundary, AppContext dependency injection, the Screen contract (+ InputCapturer/PanelInteractor capabilities), and root message flow.
  • docs/troubleshooting.md β€” config validation errors, password_env, self-signed TLS (verify_tls), lazy auth, and 403s from destructive actions requiring allow_destructive.

README polish

  • Fixed the key table to match the actual bindings:
    • blocking toggle is d, not space
    • tab/enter/β†’ descend into the panel; they do not cycle screens (there was no shift+tab binding)
    • documented esc (climb back) and ctrl+t (cycle theme)
  • Added the signature Gloss default to the theme list (was omitted).
  • Added CI / pkg.go.dev / MIT / Go-version badges.
  • Linked the three new docs from the Development section.

All doc content verified against the source (internal/tui/core/keys.go, app.go, context.go, internal/config/validate.go, internal/theme).

Test plan

  • All internal doc links resolve to existing files
  • Skim rendered Markdown on the PR page

- docs/keys.md: complete key reference incl. the two-zone (rail/panel)
  focus model, global vs zone-scoped keys, and the command palette.
- docs/architecture.md: package layout, the domain/TUI dependency
  boundary, AppContext injection, the Screen contract, and message flow.
- docs/troubleshooting.md: config validation errors, password_env,
  self-signed TLS, lazy auth, and 403s from destructive actions.
- README: fix the key table (blocking is 'd' not 'space'; tab descends
  into the panel rather than cycling screens), add the Gloss default to
  the theme list, add CI/pkg.go.dev/license/Go badges, and link the new
  docs from the Development section.
@netlify

netlify Bot commented Jul 26, 2026

Copy link
Copy Markdown

βœ… Deploy Preview for tihole ready!

Name Link
πŸ”¨ Latest commit 5755408
πŸ” Latest deploy log https://app.netlify.com/projects/tihole/deploys/6a662692be3a6e0008930758
😎 Deploy Preview https://deploy-preview-7--tihole.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
πŸ€– Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@zackkitzmiller
zackkitzmiller merged commit 8b47b26 into main Jul 26, 2026
5 checks passed
@zackkitzmiller
zackkitzmiller deleted the docs/keys-architecture-troubleshooting branch July 27, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant